متد ارسال پیام
تمامی عملیات ارسال پیام در پلتفرم ما از طریق یک اندپوینت واحد انجام میشود. ساختار کلی درخواستها ثابت است و شما تنها با تغییر پارامتر action و payload نوع سرویس را تعیین میکنید.
تنظیمات اتصال
| متد | آدرس پایه (Base URL) | اندپوینت |
|---|---|---|
| POST | https://gateway.ferzz.ir/ | /send |
هدرهای الزامی
| نام هدر (Key) | مقدار (Value) | توضیحات |
|---|---|---|
Content-Type | application/json | الزامی. فرمت دادهها باید JSON باشد. |
ساختار کلی بدنه
هر درخواست JSON شامل ۳ پارامتر ثابت و یک آبجکت متغیر (payload) است.
General Request Structure
{
"token": "YOUR_ACCESS_TOKEN",
"destination": "989123456789",
"action": "SERVICE_NAME",
"payload": {
// جزئیات اخ تصاصی هر سرویس در اینجا قرار میگیرد
}
}
جدول پارامترهای عمومی
| پارامتر | نوع | اجباری | توضیحات |
|---|---|---|---|
token | string | الزامی | کلید دسترسی سرویس (دریافت از پنل). |
destination | string | الزامی | شماره موبایل (با ۹۸) یا ایمیل مقصد. |
action | string | الزامی | نوع سرویس (انتخاب از لیست زیر). |
payload | object | الزامی | آبجکت حاوی دیتای سرویس. |
سرویسها
برای شروع، یکی از روشهای احراز هویت زیر را انتخاب کنید تا مستندات مربوط به آن را ببینید:
پاسخ سرور
{
"status": 200,
"message": "Success",
"track_id": "cdd18c14-5ef8-407a-b2b0-d08877a718a7"
}
یادآوری
برای مشاهده لیست کامل کدهای خطا (4xx, 5xx) به صفحه کدهای وضعیت و خطاها مراجعه کنید.